Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Made the documentation for sleep command consistent #832 #1167

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: Made the documentation for sleep command consistent #832 #1167

wants to merge 2 commits into from
+23 −29

Conversation

divyanshkul
Copy link

Fixes #832
Audit and make documentation for command SLEEP consistent

Changes include:

  1. Fixed the structure to match the format of other commands (e.g. SET)
  2. As discussed this on the discord, removed all the references of floating point being supported, changed them to integers.
  3. Updated the Parameters and Return values sections to use markdown tables.
  4. Revised the Errors section and Examples to align them with the overall changes.

lucifercr07
lucifercr07 requested changes Oct 20, 2024
View reviewed changes
docs/src/content/docs/commands/SLEEP.md Outdated Show resolved Hide resolved
docs/src/content/docs/commands/SLEEP.md Outdated Show resolved Hide resolved
@divyanshkul
Copy link
Author

Fixed both the changes @lucifercr07

apoorvyadav1111
apoorvyadav1111 requested changes Oct 22, 2024
View reviewed changes
Copy link
Contributor

@apoorvyadav1111 apoorvyadav1111 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me. have left one comment.

docs/src/content/docs/commands/SLEEP.md
- `Condition`: This error occurs if the `seconds` parameter is not a valid floating-point number.

## Example Usage
## Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow this template here: docs/command_docs_template.md

Suggested change
## Examples
## Example Usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucifercr07 lucifercr07 lucifercr07 requested changes

@apoorvyadav1111 apoorvyadav1111 apoorvyadav1111 requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Audit and make documentation for command SLEEP consistent
3 participants
@divyanshkul @lucifercr07 @apoorvyadav1111